home *** CD-ROM | disk | FTP | other *** search
/ Aminet 40 / Aminet 40 (2000)(Schatztruhe)[!][Dec 2000].iso / Aminet / dev / lang / Python16.lha / Python-1.6 / Lib / Python1.6 / distutils / command / install.py < prev    next >
Encoding:
Python Source  |  2000-08-07  |  20.6 KB  |  543 lines
  1. """distutils.command.install
  2.  
  3. Implements the Distutils 'install' command."""
  4.  
  5. # created 1999/03/13, Greg Ward
  6.  
  7. __revision__ = "$Id: install.py,v 1.41 2000/08/07 00:48:04 gward Exp $"
  8.  
  9. import sys, os, string
  10. from types import *
  11. from distutils.core import Command, DEBUG
  12. from distutils import sysconfig
  13. from distutils.file_util import write_file
  14. from distutils.util import convert_path, subst_vars, change_root
  15. from distutils.errors import DistutilsOptionError
  16. from glob import glob
  17.  
  18. INSTALL_SCHEMES = {
  19.     'unix_prefix': {
  20.         'purelib': '$base/lib/python$py_version_short/site-packages',
  21.         'platlib': '$platbase/lib/python$py_version_short/site-packages',
  22.         'headers': '$base/include/python$py_version_short/$dist_name',
  23.         'scripts': '$base/bin',
  24.         'data'   : '$base',
  25.         },
  26.     'unix_home': {
  27.         'purelib': '$base/lib/python',
  28.         'platlib': '$base/lib/python',
  29.         'headers': '$base/include/python/$dist_name',
  30.         'scripts': '$base/bin',
  31.         'data'   : '$base',
  32.         },
  33.     'nt': {
  34.         'purelib': '$base',
  35.         'platlib': '$base',
  36.         'headers': '$base\\Include\\$dist_name',
  37.         'scripts': '$base\\Scripts',
  38.         'data'   : '$base',
  39.         },
  40.     'mac': {
  41.         'purelib': '$base:Lib',
  42.         'platlib': '$base:Mac:PlugIns',
  43.         'headers': '$base:Include:$dist_name',
  44.         'scripts': '$base:Scripts',
  45.         'data'   : '$base',
  46.         }
  47.     }
  48.  
  49.  
  50. class install (Command):
  51.  
  52.     description = "install everything from build directory"
  53.  
  54.     user_options = [
  55.         # Select installation scheme and set base director(y|ies)
  56.         ('prefix=', None,
  57.          "installation prefix"),
  58.         ('exec-prefix=', None,
  59.          "(Unix only) prefix for platform-specific files"),
  60.         ('home=', None,
  61.          "(Unix only) home directory to install under"),
  62.  
  63.         # Or, just set the base director(y|ies)
  64.         ('install-base=', None,
  65.          "base installation directory (instead of --prefix or --home)"),
  66.         ('install-platbase=', None,
  67.          "base installation directory for platform-specific files " +
  68.          "(instead of --exec-prefix or --home)"),
  69.         ('root=', None,
  70.          "install everything relative to this alternate root directory"),
  71.  
  72.         # Or, explicitly set the installation scheme
  73.         ('install-purelib=', None,
  74.          "installation directory for pure Python module distributions"),
  75.         ('install-platlib=', None,
  76.          "installation directory for non-pure module distributions"),
  77.         ('install-lib=', None,
  78.          "installation directory for all module distributions " +
  79.          "(overrides --install-purelib and --install-platlib)"),
  80.  
  81.         ('install-headers=', None,
  82.          "installation directory for C/C++ headers"),
  83.         ('install-scripts=', None,
  84.          "installation directory for Python scripts"),
  85.         ('install-data=', None,
  86.          "installation directory for data files"),
  87.  
  88.         # For lazy debuggers who just want to test the install
  89.         # commands without rerunning "build" all the time
  90.         ('skip-build', None,
  91.          "skip rebuilding everything (for testing/debugging)"),
  92.  
  93.         # Where to install documentation (eventually!)
  94.         #('doc-format=', None, "format of documentation to generate"),
  95.         #('install-man=', None, "directory for Unix man pages"),
  96.         #('install-html=', None, "directory for HTML documentation"),
  97.         #('install-info=', None, "directory for GNU info files"),
  98.  
  99.         ('record=', None,
  100.          "filename in which to record list of installed files"),
  101.         ]
  102.  
  103.     # 'sub_commands': a list of commands this command might have to run to
  104.     # get its work done.  Each command is represented as a tuple (method,
  105.     # command) where 'method' is the name of a method to call that returns
  106.     # true if 'command' (the sub-command name, a string) needs to be run.
  107.     # If 'method' is None, assume that 'command' must always be run.
  108.     sub_commands = [('has_lib', 'install_lib'),
  109.                     ('has_headers', 'install_headers'),
  110.                     ('has_scripts', 'install_scripts'),
  111.                     ('has_data', 'install_data'),
  112.                    ]
  113.  
  114.  
  115.     def initialize_options (self):
  116.  
  117.         # High-level options: these select both an installation base
  118.         # and scheme.
  119.         self.prefix = None
  120.         self.exec_prefix = None
  121.         self.home = None
  122.  
  123.         # These select only the installation base; it's up to the user to
  124.         # specify the installation scheme (currently, that means supplying
  125.         # the --install-{platlib,purelib,scripts,data} options).
  126.         self.install_base = None
  127.         self.install_platbase = None
  128.         self.root = None
  129.  
  130.         # These options are the actual installation directories; if not
  131.         # supplied by the user, they are filled in using the installation
  132.         # scheme implied by prefix/exec-prefix/home and the contents of
  133.         # that installation scheme.
  134.         self.install_purelib = None     # for pure module distributions
  135.         self.install_platlib = None     # non-pure (dists w/ extensions)
  136.         self.install_headers = None     # for C/C++ headers
  137.         self.install_lib = None         # set to either purelib or platlib
  138.         self.install_scripts = None
  139.         self.install_data = None
  140.  
  141.         # These two are for putting non-packagized distributions into their
  142.         # own directory and creating a .pth file if it makes sense.
  143.         # 'extra_path' comes from the setup file; 'install_path_file' is
  144.         # set only if we determine that it makes sense to install a path
  145.         # file.
  146.         self.extra_path = None
  147.         self.install_path_file = 0
  148.  
  149.         self.skip_build = 0
  150.  
  151.         # These are only here as a conduit from the 'build' command to the
  152.         # 'install_*' commands that do the real work.  ('build_base' isn't
  153.         # actually used anywhere, but it might be useful in future.)  They
  154.         # are not user options, because if the user told the install
  155.         # command where the build directory is, that wouldn't affect the
  156.         # build command.
  157.         self.build_base = None
  158.         self.build_lib = None
  159.  
  160.         # Not defined yet because we don't know anything about
  161.         # documentation yet.
  162.         #self.install_man = None
  163.         #self.install_html = None
  164.         #self.install_info = None
  165.  
  166.         self.record = None
  167.  
  168.     def finalize_options (self):
  169.  
  170.         # This method (and its pliant slaves, like 'finalize_unix()',
  171.         # 'finalize_other()', and 'select_scheme()') is where the default
  172.         # installation directories for modules, extension modules, and
  173.         # anything else we care to install from a Python module
  174.         # distribution.  Thus, this code makes a pretty important policy
  175.         # statement about how third-party stuff is added to a Python
  176.         # installation!  Note that the actual work of installation is done
  177.         # by the relatively simple 'install_*' commands; they just take
  178.         # their orders from the installation directory options determined
  179.         # here.
  180.  
  181.         # Check for errors/inconsistencies in the options; first, stuff
  182.         # that's wrong on any platform.
  183.  
  184.         if ((self.prefix or self.exec_prefix or self.home) and
  185.             (self.install_base or self.install_platbase)):
  186.             raise DistutilsOptionError, \
  187.                   ("must supply either prefix/exec-prefix/home or " +
  188.                    "install-base/install-platbase -- not both")
  189.  
  190.         # Next, stuff that's wrong (or dubious) only on certain platforms.
  191.         if os.name == 'posix':
  192.             if self.home and (self.prefix or self.exec_prefix):
  193.                 raise DistutilsOptionError, \
  194.                       ("must supply either home or prefix/exec-prefix -- " +
  195.                        "not both")
  196.         else:
  197.             if self.exec_prefix:
  198.                 self.warn ("exec-prefix option ignored on this platform")
  199.                 self.exec_prefix = None
  200.             if self.home:
  201.                 self.warn ("home option ignored on this platform")
  202.                 self.home = None
  203.  
  204.         # Now the interesting logic -- so interesting that we farm it out
  205.         # to other methods.  The goal of these methods is to set the final
  206.         # values for the install_{lib,scripts,data,...}  options, using as
  207.         # input a heady brew of prefix, exec_prefix, home, install_base,
  208.         # install_platbase, user-supplied versions of
  209.         # install_{purelib,platlib,lib,scripts,data,...}, and the
  210.         # INSTALL_SCHEME dictionary above.  Phew!
  211.  
  212.         self.dump_dirs ("pre-finalize_{unix,other}")
  213.  
  214.         if os.name == 'posix':
  215.             self.finalize_unix ()
  216.         else:
  217.             self.finalize_other ()
  218.  
  219.         self.dump_dirs ("post-finalize_{unix,other}()")
  220.  
  221.         # Expand configuration variables, tilde, etc. in self.install_base
  222.         # and self.install_platbase -- that way, we can use $base or
  223.         # $platbase in the other installation directories and not worry
  224.         # about needing recursive variable expansion (shudder).
  225.  
  226.         py_version = (string.split(sys.version))[0]
  227.         self.config_vars = {'dist_name': self.distribution.get_name(),
  228.                             'dist_version': self.distribution.get_version(),
  229.                             'dist_fullname': self.distribution.get_fullname(),
  230.                             'py_version': py_version,
  231.                             'py_version_short': py_version[0:3],
  232.                             'sys_prefix': sysconfig.PREFIX,
  233.                             'sys_exec_prefix': sysconfig.EXEC_PREFIX,
  234.                            }
  235.         self.expand_basedirs ()
  236.  
  237.         self.dump_dirs ("post-expand_basedirs()")
  238.  
  239.         # Now define config vars for the base directories so we can expand
  240.         # everything else.
  241.         self.config_vars['base'] = self.install_base
  242.         self.config_vars['platbase'] = self.install_platbase
  243.  
  244.         if DEBUG:
  245.             from pprint import pprint
  246.             print "config vars:"
  247.             pprint (self.config_vars)
  248.  
  249.         # Expand "~" and configuration variables in the installation
  250.         # directories.
  251.         self.expand_dirs ()
  252.  
  253.         self.dump_dirs ("post-expand_dirs()")
  254.  
  255.         # Pick the actual directory to install all modules to: either
  256.         # install_purelib or install_platlib, depending on whether this
  257.         # module distribution is pure or not.  Of course, if the user
  258.         # already specified install_lib, use their selection.
  259.         if self.install_lib is None:
  260.             if self.distribution.ext_modules: # has extensions: non-pure
  261.                 self.install_lib = self.install_platlib
  262.             else:
  263.                 self.install_lib = self.install_purelib
  264.                     
  265.         # Well, we're not actually fully completely finalized yet: we still
  266.         # have to deal with 'extra_path', which is the hack for allowing
  267.         # non-packagized module distributions (hello, Numerical Python!) to
  268.         # get their own directories.
  269.         self.handle_extra_path ()
  270.         self.install_libbase = self.install_lib # needed for .pth file
  271.         self.install_lib = os.path.join (self.install_lib, self.extra_dirs)
  272.  
  273.         # If a new root directory was supplied, make all the installation
  274.         # dirs relative to it.
  275.         if self.root is not None:
  276.             for name in ('libbase', 'lib', 'purelib', 'platlib',
  277.                          'scripts', 'data', 'headers'):
  278.                 attr = "install_" + name
  279.                 new_val = change_root (self.root, getattr (self, attr))
  280.                 setattr (self, attr, new_val)
  281.  
  282.         self.dump_dirs ("after prepending root")
  283.  
  284.         # Find out the build directories, ie. where to install from.
  285.         self.set_undefined_options ('build',
  286.                                     ('build_base', 'build_base'),
  287.                                     ('build_lib', 'build_lib'))
  288.  
  289.         # Punt on doc directories for now -- after all, we're punting on
  290.         # documentation completely!
  291.  
  292.     # finalize_options ()
  293.  
  294.  
  295.     def dump_dirs (self, msg):
  296.         if DEBUG:
  297.             from distutils.fancy_getopt import longopt_xlate
  298.             print msg + ":"
  299.             for opt in self.user_options:
  300.                 opt_name = opt[0]
  301.                 if opt_name[-1] == "=":
  302.                     opt_name = opt_name[0:-1]
  303.                 opt_name = string.translate (opt_name, longopt_xlate)
  304.                 val = getattr (self, opt_name)
  305.                 print "  %s: %s" % (opt_name, val)
  306.  
  307.  
  308.     def finalize_unix (self):
  309.         
  310.         if self.install_base is not None or self.install_platbase is not None:
  311.             if ((self.install_lib is None and
  312.                  self.install_purelib is None and
  313.                  self.install_platlib is None) or
  314.                 self.install_headers is None or
  315.                 self.install_scripts is None or
  316.                 self.install_data is None):
  317.                 raise DistutilsOptionError, \
  318.                       "install-base or install-platbase supplied, but " + \
  319.                       "installation scheme is incomplete"
  320.             return
  321.  
  322.         if self.home is not None:
  323.             self.install_base = self.install_platbase = self.home
  324.             self.select_scheme ("unix_home")
  325.         else:
  326.             if self.prefix is None:
  327.                 if self.exec_prefix is not None:
  328.                     raise DistutilsOptionError, \
  329.                           "must not supply exec-prefix without prefix"
  330.  
  331.                 self.prefix = os.path.normpath (sys.prefix)
  332.                 self.exec_prefix = os.path.normpath (sys.exec_prefix)
  333.                 self.install_path_file = 1
  334.  
  335.             else:
  336.                 if self.exec_prefix is None:
  337.                     self.exec_prefix = self.prefix
  338.  
  339.  
  340.             # XXX since we don't *know* that a user-supplied prefix really
  341.             # points to another Python installation, we can't be sure that
  342.             # writing a .pth file there will actually work -- so we don't
  343.             # try.  That is, we only set 'install_path_file' if the user
  344.             # didn't supply prefix.  There are certainly circumstances
  345.             # under which we *should* install a .pth file when the user
  346.             # supplies a prefix, namely when that prefix actually points to
  347.             # another Python installation.  Hmmm.
  348.  
  349.             self.install_base = self.prefix
  350.             self.install_platbase = self.exec_prefix
  351.             self.select_scheme ("unix_prefix")
  352.  
  353.     # finalize_unix ()
  354.  
  355.  
  356.     def finalize_other (self):          # Windows and Mac OS for now
  357.  
  358.         if self.prefix is None:
  359.             self.prefix = os.path.normpath (sys.prefix)
  360.             self.install_path_file = 1
  361.  
  362.         # XXX same caveat regarding 'install_path_file' as in
  363.         # 'finalize_unix()'.
  364.  
  365.         self.install_base = self.install_platbase = self.prefix
  366.         try:
  367.             self.select_scheme (os.name)
  368.         except KeyError:
  369.             raise DistutilsPlatformError, \
  370.                   "I don't know how to install stuff on '%s'" % os.name
  371.  
  372.     # finalize_other ()
  373.  
  374.  
  375.     def select_scheme (self, name):
  376.         # it's the caller's problem if they supply a bad name!
  377.         scheme = INSTALL_SCHEMES[name]
  378.         for key in ('purelib', 'platlib', 'headers', 'scripts', 'data'):
  379.             attrname = 'install_' + key
  380.             if getattr(self, attrname) is None:
  381.                 setattr(self, attrname, scheme[key])
  382.  
  383.  
  384.     def _expand_attrs (self, attrs):
  385.         for attr in attrs:
  386.             val = getattr (self, attr)
  387.             if val is not None:
  388.                 if os.name == 'posix':
  389.                     val = os.path.expanduser (val)
  390.                 val = subst_vars (val, self.config_vars)
  391.                 setattr (self, attr, val)
  392.  
  393.  
  394.     def expand_basedirs (self):
  395.         self._expand_attrs (['install_base',
  396.                              'install_platbase',
  397.                              'root'])        
  398.  
  399.     def expand_dirs (self):
  400.         self._expand_attrs (['install_purelib',
  401.                              'install_platlib',
  402.                              'install_lib',
  403.                              'install_headers',
  404.                              'install_scripts',
  405.                              'install_data',])
  406.  
  407.  
  408.     def handle_extra_path (self):
  409.  
  410.         if self.extra_path is None:
  411.             self.extra_path = self.distribution.extra_path
  412.  
  413.         if self.extra_path is not None:
  414.             if type (self.extra_path) is StringType:
  415.                 self.extra_path = string.split (self.extra_path, ',')
  416.  
  417.             if len (self.extra_path) == 1:
  418.                 path_file = extra_dirs = self.extra_path[0]
  419.             elif len (self.extra_path) == 2:
  420.                 (path_file, extra_dirs) = self.extra_path
  421.             else:
  422.                 raise DistutilsOptionError, \
  423.                       "'extra_path' option must be a list, tuple, or " + \
  424.                       "comma-separated string with 1 or 2 elements"
  425.  
  426.             # convert to local form in case Unix notation used (as it
  427.             # should be in setup scripts)
  428.             extra_dirs = convert_path (extra_dirs)
  429.  
  430.         else:
  431.             path_file = None
  432.             extra_dirs = ''
  433.  
  434.         # XXX should we warn if path_file and not extra_dirs? (in which
  435.         # case the path file would be harmless but pointless)
  436.         self.path_file = path_file
  437.         self.extra_dirs = extra_dirs
  438.  
  439.     # handle_extra_path ()
  440.  
  441.  
  442.     def get_sub_commands (self):
  443.         """Return the list of subcommands that we need to run.  This is
  444.         based on the 'subcommands' class attribute: each tuple in that list
  445.         can name a method that we call to determine if the subcommand needs
  446.         to be run for the current distribution."""
  447.         commands = []
  448.         for (method, cmd_name) in self.sub_commands:
  449.             if method is not None:
  450.                 method = getattr(self, method)
  451.             if method is None or method():
  452.                 commands.append(cmd_name)
  453.         return commands
  454.  
  455.  
  456.     def run (self):
  457.  
  458.         # Obviously have to build before we can install
  459.         if not self.skip_build:
  460.             self.run_command ('build')
  461.  
  462.         # Run all sub-commands (at least those that need to be run)
  463.         for cmd_name in self.get_sub_commands():
  464.             self.run_command (cmd_name)
  465.  
  466.         if self.path_file:
  467.             self.create_path_file ()
  468.  
  469.         # write list of installed files, if requested.
  470.         if self.record:
  471.             outputs = self.get_outputs()
  472.             if self.root:               # strip any package prefix
  473.                 root_len = len(self.root)
  474.                 for counter in xrange (len (outputs)):
  475.                     outputs[counter] = outputs[counter][root_len:]
  476.             self.execute(write_file,
  477.                          (self.record, outputs),
  478.                          "writing list of installed files to '%s'" %
  479.                          self.record)
  480.  
  481.         normalized_path = map (os.path.normpath, sys.path)
  482.         if (not (self.path_file and self.install_path_file) and
  483.             os.path.normpath (self.install_lib) not in normalized_path):
  484.             self.warn (("modules installed to '%s', which is not in " +
  485.                         "Python's module search path (sys.path) -- " +
  486.                         "you'll have to change the search path yourself") %
  487.                        self.install_lib)
  488.  
  489.     # run ()
  490.  
  491.  
  492.     def has_lib (self):
  493.         """Return true if the current distribution has any Python
  494.         modules to install."""
  495.         return (self.distribution.has_pure_modules() or
  496.                 self.distribution.has_ext_modules())
  497.  
  498.     def has_headers (self):
  499.         return self.distribution.has_headers()
  500.  
  501.     def has_scripts (self):
  502.         return self.distribution.has_scripts()
  503.  
  504.     def has_data (self):
  505.         return self.distribution.has_data_files()
  506.  
  507.  
  508.     def get_outputs (self):
  509.         # This command doesn't have any outputs of its own, so just
  510.         # get the outputs of all its sub-commands.
  511.         outputs = []
  512.         for cmd_name in self.get_sub_commands():
  513.             cmd = self.get_finalized_command (cmd_name)
  514.             outputs.extend (cmd.get_outputs())
  515.  
  516.         return outputs
  517.  
  518.  
  519.     def get_inputs (self):
  520.         # XXX gee, this looks familiar ;-(
  521.         inputs = []
  522.         for cmd_name in self.get_sub_commands():
  523.             cmd = self.get_finalized_command (cmd_name)
  524.             inputs.extend (cmd.get_inputs())
  525.  
  526.         return inputs
  527.  
  528.  
  529.     def create_path_file (self):
  530.         filename = os.path.join (self.install_libbase,
  531.                                  self.path_file + ".pth")
  532.         if self.install_path_file:
  533.             self.execute (write_file,
  534.                           (filename, [self.extra_dirs]),
  535.                           "creating %s" % filename)
  536.         else:
  537.             self.warn (("path file '%s' not created for alternate or custom " +
  538.                         "installation (path files only work with standard " +
  539.                         "installations)") %
  540.                        filename)
  541.  
  542. # class install
  543.